Node / meshtastic / Meshtastic-Android / files / feature / docs / src / commonMain / kotlin / org / meshtastic / feature / docs / ai / AIDocAssistant.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.docs.ai

Tff7b72import T7ee787kotlinx.coroutines.flow.StateFlow

Tff7b72import T7ee787org.meshtastic.feature.docs.model.AIDocAssistantResult

Tff7b72import T7ee787org.meshtastic.feature.docs.model.ModelReadiness

T8b949e/**

* Shared abstraction over the platform-specific docs AI assistant.

*

* Bindings:

* - Android `google` flavor: Gemini Nano implementation

* - Android `fdroid` flavor: keyword-search fallback

* - Desktop/iOS: keyword-search fallback

*/

Tff7b72interface T56d364AIDocAssistant Tb4b4b4{

T8b949e/** Whether the AI assistant is available on the current platform/device. */

Tff7b72suspend Tff7b72fun Td2a8ffisSupportedTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Boolean

T8b949e/** Current model readiness state for lifecycle/download UX. */

Tff7b72val Te6edf3modelStatusTb4b4b4: Te6edf3StateFlowTff7b72<Te6edf3ModelReadinessTff7b72>

T8b949e/** Answer a user question about Meshtastic using bundled documentation context. */

Tff7b72suspend Tff7b72fun Td2a8ffanswerTb4b4b4(Te6edf3questionTb4b4b4: Tffa657StringTb4b4b4, Te6edf3currentPageIdTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4: Te6edf3AIDocAssistantResult

T8b949e/** Answer a user question about Meshtastic, streaming the results as they arrive. */

Tff7b72fun Td2a8ffanswerStreamTb4b4b4(

Te6edf3questionTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3currentPageIdTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)Tb4b4b4: Te6edf3kotlinxTb4b4b4.Te6edf3coroutinesTb4b4b4.Te6edf3flowTb4b4b4.Te6edf3FlowTff7b72<Te6edf3AIDocAssistantResultTff7b72>

T8b949e/** Reset the conversation session. Call when starting a new conversation thread. */

Tff7b72fun Td2a8ffresetSessionTb4b4b4(Tb4b4b4)

Tb4b4b4}